/*-
 *
 *  * Copyright 2015 Skymind,Inc.
 *  *
 *  *    Licensed under the Apache License, Version 2.0 (the "License");
 *  *    you may not use this file except in compliance with the License.
 *  *    You may obtain a copy of the License at
 *  *
 *  *        http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  *    Unless required by applicable law or agreed to in writing, software
 *  *    distributed under the License is distributed on an "AS IS" BASIS,
 *  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  *    See the License for the specific language governing permissions and
 *  *    limitations under the License.
 *
 */

package org.deeplearning4j.text.sentenceiterator;

/**
 * A sentence iterator that knows how to iterate over sentence.
 * This can be used in conjunction with more advanced NLP techniques
 * to clearly separate sentences out, or be simpler when as much
 * complexity is not needed.
 * @author Adam Gibson
 *
 */
public interface SentenceIterator {

    /**
     * Gets the next sentence or null
     * if there's nothing left (Do yourself a favor and
     * check hasNext() )
     * 
     * @return the next sentence in the iterator
     */
    String nextSentence();

    /**
     * Same idea as {@link java.util.Iterator}
     * @return whether there's anymore sentences left
     */
    boolean hasNext();

    /**
     * Resets the iterator to the beginning
     */
    void reset();

    /**
     * Allows for any finishing (closing of input streams or the like)
     */
    void finish();


    SentencePreProcessor getPreProcessor();

    void setPreProcessor(SentencePreProcessor preProcessor);


}
